Skip to content

gh-130160: use .. program:: directive for documenting ensurepip CLI#130253

Merged
pfmoore merged 2 commits into
python:mainfrom
Mr-Sunglasses:fix/130160
Feb 18, 2025
Merged

gh-130160: use .. program:: directive for documenting ensurepip CLI#130253
pfmoore merged 2 commits into
python:mainfrom
Mr-Sunglasses:fix/130160

Conversation

@Mr-Sunglasses

@Mr-Sunglasses Mr-Sunglasses commented Feb 18, 2025 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

@ghost

ghost commented Feb 18, 2025 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Feb 18, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Feb 18, 2025
Closed
6 tasks
@Mr-Sunglasses

Mr-Sunglasses commented Feb 18, 2025

Copy link
Copy Markdown
Contributor Author

@sobolevn , @picnixz ptal

sobolevn
sobolevn reviewed Feb 18, 2025
View reviewed changes

@sobolevn sobolevn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
Снимок экрана 2025-02-18 в 14 08 39

I would recommend changing pipX to pipN, because there's now a tool called pipx.

Thanks for the PR and congrats! 🎉

sobolevn
sobolevn reviewed Feb 18, 2025
View reviewed changes
Comment thread Doc/library/ensurepip.rst Outdated

By default, the scripts ``pipX`` and ``pipX.Y`` will be installed (where
X.Y stands for the version of Python used to invoke ``ensurepip``). The
By default, the scripts ``pipN`` and ``pipN.Y`` will be installed (where

@sobolevn sobolevn Feb 18, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe pipN.M?

@pfmoore pfmoore Feb 18, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why change this at all? pipX.Y is the normal convention here, used in the pip documentation.

@sobolevn sobolevn Feb 18, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, this change is unrelated anyway and no users complained about it. I agree with @pfmoore

pfmoore
pfmoore requested changes Feb 18, 2025
View reviewed changes

@pfmoore pfmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please leave the pipX.Y naming convention unchanged.

@bedevere-app

bedevere-app Bot commented Feb 18, 2025

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@pfmoore

pfmoore commented Feb 18, 2025

Copy link
Copy Markdown
Member

Sorry I hadn’t seen the comment by @sobolevn regarding the pipx application. Nevertheless, I disagree - the pipX.Y convention is well established, and consistency with existing terminology is important.

@Mr-Sunglasses

Mr-Sunglasses commented Feb 18, 2025

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again.

@bedevere-app

bedevere-app Bot commented Feb 18, 2025

Copy link
Copy Markdown

Thanks for making the requested changes!

@pfmoore: please review the changes made to this pull request.

@bedevere-app bedevere-app Bot requested a review from pfmoore February 18, 2025 11:51
@pfmoore

pfmoore commented Feb 18, 2025

Copy link
Copy Markdown
Member

Thanks! LGTM.

@pfmoore pfmoore merged commit 8cd7f8b into python:main Feb 18, 2025
@sobolevn

sobolevn commented Feb 18, 2025

Copy link
Copy Markdown
Member

We usually backport doc changes, should we in this case?

@sobolevn sobolevn added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Feb 18, 2025
@miss-islington-app

miss-islington-app Bot commented Feb 18, 2025

Copy link
Copy Markdown

Thanks @Mr-Sunglasses for the PR, and @pfmoore for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app

miss-islington-app Bot commented Feb 18, 2025

Copy link
Copy Markdown

Thanks @Mr-Sunglasses for the PR, and @pfmoore for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 18, 2025
@Mr-Sunglasses @miss-islington
pythongh-130160: use .. program:: directive for documenting `ensure…
45a3590 
…pip` CLI (pythongh-130253)

(cherry picked from commit 8cd7f8b)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
@bedevere-app

bedevere-app Bot commented Feb 18, 2025

Copy link
Copy Markdown

GH-130258 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Feb 18, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 18, 2025
@Mr-Sunglasses @miss-islington
pythongh-130160: use .. program:: directive for documenting `ensure…
d47bff3 
…pip` CLI (pythongh-130253)

(cherry picked from commit 8cd7f8b)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
@bedevere-app

bedevere-app Bot commented Feb 18, 2025

Copy link
Copy Markdown

GH-130259 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Feb 18, 2025
@pfmoore

pfmoore commented Feb 18, 2025

Copy link
Copy Markdown
Member

We usually backport doc changes, should we in this case?

I don't know the policy for doc changes, but if that's the usual approach, I see no reason not to.

pfmoore pushed a commit that referenced this pull request Feb 18, 2025
@miss-islington @Mr-Sunglasses
[3.13] gh-130160: use .. program:: directive for documenting `ensur…
a273543 
…epip` CLI (gh-130253) (gh-130259)

gh-130160: use `.. program::` directive for documenting `ensurepip` CLI (gh-130253)
(cherry picked from commit 8cd7f8b)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
pfmoore pushed a commit that referenced this pull request Feb 18, 2025
@miss-islington @Mr-Sunglasses
[3.12] gh-130160: use .. program:: directive for documenting `ensur…
aeefac9 
…epip` CLI (gh-130253) (gh-130258)

gh-130160: use `.. program::` directive for documenting `ensurepip` CLI (gh-130253)
(cherry picked from commit 8cd7f8b)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sobolevn sobolevn sobolevn left review comments

@pfmoore pfmoore pfmoore approved these changes

@pradyunsg pradyunsg Awaiting requested review from pradyunsg pradyunsg is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Use .. program:: and .. option:: directives for modules with a documented CLI

3 participants

@Mr-Sunglasses @pfmoore @sobolevn